/****

    activequant - activestocks.eu

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

	
	contact  : contact@activestocks.eu
    homepage : http://www.activestocks.eu

****/
package org.activequant.core.types;


/**
 *  Symbols.<br>
 *  An enum, holds the desc(String) associated variable.<br/>
 *  Defined values:<br/>
 *  FUTURE("Future"),<br/>
 *  FUTURE_OPTION("Future Option"),<br/>
 *	INDEX("Index"),<br/>
 *	OPTION("Option"),<br/>
 *	STOCK("Stock"),<br/>
 *	CASH("Cash/Forex");
 * <br/>
 * <b>History:</b><br/>
 *  - [13.07.2006] Created (Erik Nijkamp)<br>
 *
 *
 *  @author Erik Nijkamp
 */
public enum SecurityType {
    
    // Standard generic names
	FUTURE("Future"),
	FUTURE_OPTION("Future Option"),
	INDEX("Index"),
	OPTION("Option"),
	STOCK("Stock"),
	CASH("Cash/Forex"),
	BAG("Bag");
	/**
	 * holds the associated desc(String)
	 */
	private String desc;
	/**
	 * constructs a SecurityType enum using the given desc(String) to set its associated desc(String)
	 * @param desc
	 */
	SecurityType(String desc) {
		this.desc = desc;
	}
	/**
	 * Returns the name of this enum constant, exactly as declared in its enum declaration
	 */
	public String toString() {
		return name();
	}
	
	/**
	 * returns the associated desc(String)
	 * @return the desc
	 */
	public String getDesc() {
		return desc;
	}
}